SpinButton: Explain meaning of nullable Adjustment
authorDaniel Boles <dboles@src.gnome.org>
Wed, 22 Nov 2017 20:27:26 +0000 (20:27 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Wed, 22 Nov 2017 20:58:00 +0000 (20:58 +0000)
configure() marked the @adj argument as (allow-none) but did not explain
what passing NULL would do. Fix that, and move it to (nullable) as well.

gtk/gtkspinbutton.c

index 3ffaae301e5111d61b6d441831030627fae4f7b4..8587df9582da9f603425d8e967f61fb080877b37 100644 (file)
@@ -1915,13 +1915,13 @@ gtk_spin_button_default_output (GtkSpinButton *spin_button)
 /**
  * gtk_spin_button_configure:
  * @spin_button: a #GtkSpinButton
- * @adjustment: (allow-none):  a #GtkAdjustment
+ * @adjustment: (nullable): a #GtkAdjustment to replace the spin button’s
+ *     existing adjustment, or %NULL to leave its current adjustment unchanged
  * @climb_rate: the new climb rate
  * @digits: the number of decimal places to display in the spin button
  *
  * Changes the properties of an existing spin button. The adjustment,
- * climb rate, and number of decimal places are all changed accordingly,
- * after this function call.
+ * climb rate, and number of decimal places are updated accordingly.
  */
 void
 gtk_spin_button_configure (GtkSpinButton *spin_button,